Sign in

v4

OpenAPI 3.0.02026-07-3137328230.2 KB
Live Tracking - General

Retrieve a gear summary for a guild roster. Supports two scopes: "pull" uses combat log data from raid encounters, "armory" uses the latest Blizzard armory snapshot.

The <code>pull</code> scope relies on combat log data retrieved from the Raider.IO Desktop App. The <code>armory</code> scope uses Blizzard armory data and does not require the Desktop App.<br><br>Identify the guild using <b>either</b> <code>guild_id</code> <b>or</b> the <code>region</code>/<code>realm</code>/<code>guild</code> combination.

get/api/v1/live-tracking/guild/gear-summary

Query parameters

access_keystring

The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.

The API key from your RaiderIO App: http://raider.io/settings/apps. Apps with API keys have higher rate limits.

raid'the-tidebound-grotto' | 'the-venomous-abyss' | 'sporefall' | 'tier-mn-1' | 'manaforge-omega' | 'liberation-of-undermine' | 'nerubar-palace' | 'blackrock-depths' | 'awakened-amirdrassil-the-dreams-hope' | 'awakened-aberrus-the-shadowed-crucible' | 'awakened-vault-of-the-incarnates' | 'amirdrassil-the-dreams-hope' | 'aberrus-the-shadowed-crucible' | 'vault-of-the-incarnates' | 'fated-sepulcher-of-the-first-ones' | 'fated-sanctum-of-domination' | 'fated-castle-nathria' | 'sepulcher-of-the-first-ones' | 'sanctum-of-domination' | 'castle-nathria' | 'nyalotha-the-waking-city' | 'the-eternal-palace' | 'crucible-of-storms' | 'battle-of-dazaralor' | 'uldir' | 'antorus-the-burning-throne' | 'tomb-of-sargeras' | 'the-nighthold' | 'trial-of-valor' | 'the-emerald-nightmare' | 'latest' required

Raid slug or full name (e.g. "sporefall" or "Sporefall")

Raid slug or full name (e.g. "sporefall" or "Sporefall")

difficulty'mythic' | 'heroic' | 'normal' | 'latest'

Raid difficulty. One of: mythic, heroic, normal. Optional filter.

Raid difficulty. One of: mythic, heroic, normal. Optional filter.

scope'pull' | 'armory'

Data source scope. "pull" uses combat log data from raid pulls. "armory" uses the latest armory snapshot.

Data source scope. "pull" uses combat log data from raid pulls. "armory" uses the latest armory snapshot.

advanced_searchboolean

Enable advanced search mode with additional filtering options

Enable advanced search mode with additional filtering options

before_datestring

For "pull" scope only: only consider pulls before this date (ISO 8601)

For "pull" scope only: only consider pulls before this date (ISO 8601)

bossstring

For "pull" scope only: request data from a specific boss slug

For "pull" scope only: request data from a specific boss slug

first_killboolean

For "pull" scope only: only show data from up to the first kill

For "pull" scope only: only show data from up to the first kill

periodinteger

For "pull" scope only: request data from a specific lockout period. 0 = all periods.

For "pull" scope only: request data from a specific lockout period. 0 = all periods.

pull_id0

For "pull" scope only: the ID of the pull to look up. You can get this from a raid-pulls call. Setting to 0 will fetch the latest from the guild.

For "pull" scope only: the ID of the pull to look up. You can get this from a raid-pulls call. Setting to 0 will fetch the latest from the guild.

guild_idinteger

Raider.IO guild ID. Alternative to the region/realm/guild parameters.

Raider.IO guild ID. Alternative to the region/realm/guild parameters.

region'us' | 'eu' | 'tw' | 'kr' | 'cn' | 'world'

Region to filter by. One of: world, us, eu, kr, tw Required if guild_id not provided.

Region to filter by. One of: world, us, eu, kr, tw Required if guild_id not provided.

realmstring

Realm name. Accepts slug form (e.g. "altar-of-storms") or display name (e.g. "Altar of Storms") Required if guild_id not provided.

Realm name. Accepts slug form (e.g. "altar-of-storms") or display name (e.g. "Altar of Storms") Required if guild_id not provided.

guildstring

Guild name. Not case sensitive. Required if guild_id not provided.

Guild name. Not case sensitive. Required if guild_id not provided.

Response

Successful

top20ItemLevelnumber nullable

Average item level of top 20 geared players

codeinteger

Error code if access restricted

errorstring

Error message if access restricted

widgetVersioninteger

Widget version for cache invalidation